/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.catalina.filters;

import org.apache.catalina.comet.CometEvent;
import org.apache.catalina.comet.CometFilterChain;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import java.io.IOException;

/**
 * Concrete implementation of <code>RequestFilter</code> that filters
 * based on the remote client's host name.
 *
 * @author Craig R. McClanahan
 */
public final class RemoteHostFilter extends RequestFilter {

	private static final Log log = LogFactory.getLog(RemoteHostFilter.class);


	// --------------------------------------------------------- Public Methods

	/**
	 * Extract the desired request property, and pass it (along with the
	 * specified request and response objects and associated filter chain) to
	 * the protected <code>process()</code> method to perform the actual
	 * filtering.
	 *
	 * @param request  The servlet request to be processed
	 * @param response The servlet response to be created
	 * @param chain    The filter chain for this request
	 * @throws IOException      if an input/output error occurs
	 * @throws ServletException if a servlet error occurs
	 */
	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
	                     FilterChain chain) throws IOException, ServletException {

		process(request.getRemoteHost(), request, response, chain);

	}

	/**
	 * Extract the desired request property, and pass it (along with the comet
	 * event and filter chain) to the protected <code>process()</code> method
	 * to perform the actual filtering.
	 *
	 * @param event The comet event to be processed
	 * @param chain The filter chain for this event
	 * @throws IOException      if an input/output error occurs
	 * @throws ServletException if a servlet error occurs
	 */
	@Override
	public void doFilterEvent(CometEvent event, CometFilterChain chain)
			throws IOException, ServletException {
		processCometEvent(event.getHttpServletRequest().getRemoteHost(),
				event, chain);
	}

	@Override
	protected Log getLogger() {
		return log;
	}
}
